home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIOutputStream.idl < prev    next >
Text File  |  2006-05-08  |  7KB  |  168 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Warren Harris <warren@netscape.com>
  24.  *   Darin Fisher <darin@netscape.com>
  25.  *
  26.  * Alternatively, the contents of this file may be used under the terms of
  27.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29.  * in which case the provisions of the GPL or the LGPL are applicable instead
  30.  * of those above. If you wish to allow use of your version of this file only
  31.  * under the terms of either the GPL or the LGPL, and not to allow others to
  32.  * use your version of this file under the terms of the MPL, indicate your
  33.  * decision by deleting the provisions above and replace them with the notice
  34.  * and other provisions required by the GPL or the LGPL. If you do not delete
  35.  * the provisions above, a recipient may use your version of this file under
  36.  * the terms of any one of the MPL, the GPL or the LGPL.
  37.  *
  38.  * ***** END LICENSE BLOCK ***** */
  39.  
  40. #include "nsISupports.idl"
  41.  
  42. interface nsIOutputStream;
  43. interface nsIInputStream;
  44.  
  45. %{C++
  46. /**
  47.  * The signature for the reader function passed to WriteSegments. This 
  48.  * is the "provider" of data that gets written into the stream's buffer.
  49.  *
  50.  * @param aOutStream stream being written to
  51.  * @param aClosure opaque parameter passed to WriteSegments
  52.  * @param aToSegment pointer to memory owned by the output stream
  53.  * @param aFromOffset amount already written (since WriteSegments was called)
  54.  * @param aCount length of toSegment
  55.  * @param aReadCount number of bytes written
  56.  *
  57.  * Implementers should return the following:
  58.  *
  59.  * @return NS_OK and (*aReadCount > 0) if successfully provided some data
  60.  * @return NS_OK and (*aReadCount = 0) or
  61.  * @return <any-error> if not interested in providing any data
  62.  *
  63.  * Errors are never passed to the caller of WriteSegments.
  64.  *
  65.  * @status FROZEN
  66.  */
  67. typedef NS_CALLBACK(nsReadSegmentFun)(nsIOutputStream *aOutStream,
  68.                                       void *aClosure,
  69.                                       char *aToSegment,
  70.                                       PRUint32 aFromOffset,
  71.                                       PRUint32 aCount,
  72.                                       PRUint32 *aReadCount);
  73. %}
  74.  
  75. native nsReadSegmentFun(nsReadSegmentFun);
  76.  
  77. /**
  78.  * nsIOutputStream
  79.  *
  80.  * @status FROZEN
  81.  */
  82. [scriptable, uuid(0d0acd2a-61b4-11d4-9877-00c04fa0cf4a)]
  83. interface nsIOutputStream : nsISupports
  84. {
  85.     /** 
  86.      * Close the stream. Forces the output stream to flush any buffered data.
  87.      *
  88.      * @throws NS_BASE_STREAM_WOULD_BLOCK if unable to flush without blocking 
  89.      *   the calling thread (non-blocking mode only)
  90.      */
  91.     void close();
  92.  
  93.     /**
  94.      * Flush the stream.
  95.      *
  96.      * @throws NS_BASE_STREAM_WOULD_BLOCK if unable to flush without blocking 
  97.      *   the calling thread (non-blocking mode only)
  98.      */
  99.     void flush();
  100.  
  101.     /**
  102.      * Write data into the stream.
  103.      *
  104.      * @param aBuf the buffer containing the data to be written
  105.      * @param aCount the maximum number of bytes to be written
  106.      *
  107.      * @return number of bytes written (may be less than aCount)
  108.      *
  109.      * @throws NS_BASE_STREAM_WOULD_BLOCK if writing to the output stream would
  110.      *   block the calling thread (non-blocking mode only)
  111.      * @throws <other-error> on failure
  112.      */
  113.     unsigned long write(in string aBuf, in unsigned long aCount);
  114.  
  115.     /**
  116.      * Writes data into the stream from an input stream.
  117.      *
  118.      * @param aFromStream the stream containing the data to be written
  119.      * @param aCount the maximum number of bytes to be written
  120.      *
  121.      * @return number of bytes written (may be less than aCount)
  122.      *
  123.      * @throws NS_BASE_STREAM_WOULD_BLOCK if writing to the output stream would
  124.      *    block the calling thread (non-blocking mode only)
  125.      * @throws <other-error> on failure
  126.      *
  127.      * NOTE: This method is defined by this interface in order to allow the
  128.      * output stream to efficiently copy the data from the input stream into
  129.      * its internal buffer (if any). If this method was provided as an external
  130.      * facility, a separate char* buffer would need to be used in order to call
  131.      * the output stream's other Write method.
  132.      */
  133.     unsigned long writeFrom(in nsIInputStream aFromStream,
  134.                             in unsigned long aCount);
  135.  
  136.     /**
  137.      * Low-level write method that has access to the stream's underlying buffer.
  138.      * The reader function may be called multiple times for segmented buffers.
  139.      * WriteSegments is expected to keep calling the reader until either there
  140.      * is nothing left to write or the reader returns an error.  WriteSegments
  141.      * should not call the reader with zero bytes to provide.
  142.      *
  143.      * @param aReader the "provider" of the data to be written
  144.      * @param aClosure opaque parameter passed to reader
  145.      * @param aCount the maximum number of bytes to be written
  146.      *
  147.      * @return number of bytes written (may be less than aCount)
  148.      *
  149.      * @throws NS_BASE_STREAM_WOULD_BLOCK if writing to the output stream would
  150.      *    block the calling thread (non-blocking mode only)
  151.      * @throws <other-error> on failure
  152.      *
  153.      * NOTE: this function may be unimplemented if a stream has no underlying
  154.      * buffer (e.g., socket output stream).
  155.      */
  156.     [noscript] unsigned long writeSegments(in nsReadSegmentFun aReader,
  157.                                            in voidPtr aClosure,
  158.                                            in unsigned long aCount);
  159.  
  160.     /**
  161.      * @return true if stream is non-blocking
  162.      *
  163.      * NOTE: writing to a blocking output stream will block the calling thread
  164.      * until all given data can be consumed by the stream.
  165.      */
  166.     boolean isNonBlocking();
  167. };
  168.